home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 016a / 4fc11.zip / 4COMMENT.DOC next >
Text File  |  1991-11-30  |  9KB  |  178 lines
  1.  
  2.                              4COMMENT     V1.0
  3.                                 11/16/91
  4.                 (c)Copyright Saturn Software & John Bintz
  5.  
  6.      4COMMENT  extracts file descriptions from a bbs list or a formatted
  7.      capture file, matches them to existing files, and installs the
  8.      descriptions:
  9.  
  10.      1. As comments into an achieved file (zip, arj, pak, zoo).
  11.      2. As a description in the 4dos file "descript.ion."
  12.      3. Or into a separate text file.
  13.  
  14. |    Alternatively, it will extract the comments from a archieved file and
  15. |    make a file list.
  16.  
  17.      LIMIT OF LIABILITY
  18.         4COMMENT is distributed as is.  The author makes  no representation
  19.      with respect to the fitness of the software for any particular purpose
  20.      and disclaims all warranties, expressed  or implied.  The  author will
  21.      assume no liability for  damages either  from the  direct use  of this
  22.      product or as a consequence of the use of this software.
  23.      
  24.      SHAREWARE
  25.         4COMMENT is distributed as shareware. This  means you  can evaluate
  26.      the product before  you decide  to register  it. If  you are  using it
  27.      after a couple of weeks, you should register it. You can copy 4COMMENT
  28.      or any shareware program and distributed to anyone else, provided that
  29.      neither the program nor the documentation is altered  and that  you do
  30.      not charge a fee. Because  there is  no advertising,  distribution, or
  31.      packaging cost, the price of a shareware program is often less than an
  32.      equivalent package sold through retail channels.
  33.  
  34.         The registration form is provided in a separate file.
  35.      
  36.     SYNTAX:
  37.  
  38.     4COMMENT     Displays help file
  39.  
  40.     4COMMENT DIRN FILEMASK [-c] [-4] [-t]
  41.  
  42.        -c :Installs file description as zip/arj/pak/zoo comment
  43.        -4 :Installs short description in 4dos descript.ion
  44.        -t :Installs file description in text file named "dir" in
  45.            the current subdirectory. If such a file already exists,
  46.            it will be appended to without prior destruction.
  47.            Consequently, 4COMMENT can be run multiple times.
  48. |      -g :Gets file description from comment in zip/arj/pak/zoo
  49. |          and appends to DIRN.
  50. |      -m :Mark file so that it won't be processed on a subsequent
  51. |          pass through the subdirectory
  52.  
  53.        DIRN:  Must be a qualified filename such as J:\DIRS\DIR4 or just
  54.               the filename if it resides in the current subdirectory. It
  55.               contains the descriptions of the files to be processed. The
  56.               file can be a PCB filelist or it can be a captured session
  57.               file. In this version of the program, the routine is not
  58.               very robust. A filename will not be handled correctly, if
  59.               it does not start at the first position of any line, or if
  60.               the filename stem and extension are separated by spaces.
  61.  
  62.        FILEMASK
  63.               Can be a qualified filename or any set of ambiguous characters
  64.               that DOS permits, such as "j:\dl\myfile?.*". The '-t' and '-4'
  65.               options will work regardless of extensions; the '-c' option
  66.               will not because 4COMMENT uses the text of the extension to decide
  67.               what program to shell to. For example, the extension "zip" would
  68.               cause 4COMMENT to shell to pkzip if the '-c' option were in effect.
  69.               If the zipped file was named "myfile.zi1", no shelling would
  70.               take place and no comments would be installed.
  71.  
  72.     Any compression program (PKZIP, ARJ, PAK, ZOO) used must be located
  73.     somewhere on the DOS path for the -c option to operate correctly.
  74.  
  75.  
  76.     4DOS
  77.     4COMMENT processes the "descript.ion" found in the subdirectory specified
  78.     in the filemask, or creates one if none exists.
  79.  
  80.     4COMMENT is compatible with either the 40 character descriptions of V3
  81.     or the 4096 character descriptions of V4. It handles a maximum of
  82.     500 files per directory. However, if there were many files approaching
  83.     the 4096 character comment limit, memory would become a problem before
  84.     the file limit was reached.
  85.  
  86.     In 4DOS, the text of the comment is limited to 40 characters. 4COMMENT takes
  87.     the comment to be the first 40 characters of the description which is
  88.     roughly the equivalents of the first line of a PCB description. However,
  89.     PCB allows 43 characters so there may be some truncation if the text
  90.     file is a PCB dir file or any other file that excedes the 4DOS limits.
  91.  
  92.     If there is a "descript.ion" file, new entries are added corresponding
  93.     to the files processed. If an entry for a file already exists, it is
  94.     replaced by the new description.
  95.  
  96.     4DOS V3 and V4 differ in their handling of entries to "descript.ion". In
  97.     version 3, the entire entry is text and it can be 40 characters long.
  98.     In version 4, extended descriptions are permitted and the entire
  99.     description can be up to 4096 characters long. Only 40 characters are
  100.     displayed and the remainder can be used by other programs for whatever
  101.     purpose. A control 'd', demarks the beginning of each area used by
  102.     another program.
  103.  
  104.     4COMMENT takes this into account whenever there is a new description to a
  105.     file that already exists simply by appending the extended section to the
  106.     new description. There should be no problems, but it has not been tested
  107.     in a real situation since at this date 4dos version 4 has been available
  108.     for about a week and, to my knowledge,  there are no programs which
  109.     take advantage of a control section.
  110.  
  111.     Compressed files
  112.  
  113.     Regardless of the original form of the description, 4COMMENT converts it
  114.     to a PCB type of description and installs the description in that
  115.     format as a comment. All compressed filetypes (zip, arj, pak, zoo) will
  116.     allow multiline comments.
  117.  
  118. |   When extracting comments with the -g command to make a filelist, just
  119. |   the portion of the comment that describes the file is extracted.
  120. |   Extraneous messages, bbs identification etc. are not added to the
  121. |   filelist. The demands are specific enough that a file description
  122. |   installed by some means other than 4comment might not be extracted.
  123.  
  124.     The compressor version worked with are pkzip110, arj222, zoo210, and
  125.     pak210. While I looked at arc601 and lha113, either they didn't allow
  126.     for comments or I didn't discover how to make them work.
  127.  
  128.     Text file
  129.  
  130.     If the text file option is chosen, file entries will be formatted in
  131.     a PCB format and installed in a text file called "dir." That file will
  132.     be located in the subdirectory that 4COMMENT is initiated from, rather than
  133.     in the subdirectory being operated on.
  134.  
  135. |   Another filename for the text file can be forced by entering its name
  136. |   directly following the "-t" option, e.g. "k:\robo\dl.txt".
  137.  
  138.     The file is compatible with pcbfiler and should be compatible with any
  139.     other utility that you use to process dir files.
  140.  
  141.  
  142. |   File Marking
  143.  
  144. |   File marking is intended for BBS sysops or others who repeatedly process
  145. |   the same subdirectory because of new files being added. When marking is
  146. |   enabled by the "-m" switch, the time stamp of the file is converted to
  147. |   a predefined time. When the subdirectory is processed again with the "-m"
  148. |   switch, those files time stamped with the predefined time are skipped.
  149.  
  150. |   The time is defined in the environment with a set statement in the
  151. |   autoexec.bat or with a set statement (from the command line or in a
  152. |   batch file) prior to the running of 4COMMENT. For example,
  153.  
  154. |               set 4COMMENT=01:02:12    (no spaces)
  155.  
  156. |   Any portion of the time can be ommited from the predefinition. E.g. the
  157. |   statement:
  158.  
  159. |               set 4COMMENT=::12
  160.  
  161. |   would result in processing all files except those stamped with a 12 in
  162. |   the "seconds" location. The advantage of doing this is that the altered
  163. |   time stamp would not be displayed with a "dir" command. The disadvantage
  164. |   is that one file in 30, on the average, would not be processed correctly.
  165. |   (One in thirty, because DOS allows only 30 unique numbers and the unit
  166. |   is really double-seconds rather than seconds)
  167.  
  168.  
  169.  
  170.     Errors
  171.  
  172.     If an error is reported back from one of the compression programs, a
  173.     message is displayed on the screen to the effect that an error occurred
  174.     during the run. A file ("4COMMENT.ERR") is created which specifies the
  175.     file(s) in which there an error occurred.
  176.  
  177.  
  178.